<html>
<head>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
    <title>connect (10 of 12 overloads)</title>
    <link rel="stylesheet" href="../../../boostbook.css" type="text/css">
    <meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
    <link rel="home" href="../../../index.html" title="Asio">
    <link rel="up" href="../connect.html" title="connect">
    <link rel="prev" href="overload9.html" title="connect (9 of 12 overloads)">
    <link rel="next" href="overload11.html" title="connect (11 of 12 overloads)">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
    <tr>
        <td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../../asio.png"></td>
    </tr>
</table>
<hr>
<div class="spirit-nav">
    <a accesskey="p" href="overload9.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u"
                                                                                          href="../connect.html"><img
        src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png"
                                                                                            alt="Home"></a><a
        accesskey="n" href="overload11.html"><img src="../../../next.png" alt="Next"></a>
</div>
<div class="section">
    <div class="titlepage">
        <div>
            <div><h4 class="title">
                <a name="asio.reference.connect.overload10"></a><a class="link" href="overload10.html"
                                                                   title="connect (10 of 12 overloads)">connect (10 of
                12
                overloads)</a>
            </h4></div>
        </div>
    </div>
    <p>
        (Deprecated: Use range overload.) Establishes a socket connection by trying
        each endpoint in a sequence.
    </p>
    <pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span>
    <span class="keyword">typename</span> <a class="link" href="../Protocol.html"
                                             title="Protocol requirements">Protocol</a><span class="special">,</span>
    <span class="keyword">typename</span> <a class="link" href="../Executor1.html" title="Executor requirements">Executor</a><span
                class="special">,</span>
    <span class="keyword">typename</span> <span class="identifier">Iterator</span><span class="special">,</span>
    <span class="keyword">typename</span> <a class="link" href="../ConnectCondition.html"
                                             title="Connect condition requirements">ConnectCondition</a><span
                class="special">&gt;</span>
<span class="identifier">Iterator</span> <span class="identifier">connect</span><span class="special">(</span>
    <span class="identifier">basic_socket</span><span class="special">&lt;</span> <span
                class="identifier">Protocol</span><span class="special">,</span> <span
                class="identifier">Executor</span> <span class="special">&gt;</span> <span class="special">&amp;</span> <span
                class="identifier">s</span><span class="special">,</span>
    <span class="identifier">Iterator</span> <span class="identifier">begin</span><span class="special">,</span>
    <span class="identifier">ConnectCondition</span> <span class="identifier">connect_condition</span><span
                class="special">,</span>
    <span class="identifier">asio</span><span class="special">::</span><span class="identifier">error_code</span> <span
                class="special">&amp;</span> <span class="identifier">ec</span><span class="special">,</span>
    <span class="keyword">typename</span> <span class="identifier">constraint</span><span
                class="special">&lt;!</span><span class="identifier">is_endpoint_sequence</span><span class="special">&lt;</span> <span
                class="identifier">Iterator</span> <span class="special">&gt;::</span><span
                class="identifier">value</span> <span class="special">&gt;::</span><span class="identifier">type</span>  <span
                class="special">=</span> <span class="number">0</span><span class="special">);</span>
</pre>
    <p>
        This function attempts to connect a socket to one of a sequence of endpoints.
        It does this by repeated calls to the socket's <code class="computeroutput"><span
            class="identifier">connect</span></code>
        member function, once for each endpoint in the sequence, until a connection
        is successfully established.
    </p>
    <h6>
        <a name="asio.reference.connect.overload10.h0"></a>
        <span><a name="asio.reference.connect.overload10.parameters"></a></span><a class="link"
                                                                                   href="overload10.html#asio.reference.connect.overload10.parameters">Parameters</a>
    </h6>
    <div class="variablelist">
        <p class="title"><b></b></p>
        <dl>
            <dt><span class="term">s</span></dt>
            <dd><p>
                The socket to be connected. If the socket is already open, it will
                be closed.
            </p></dd>
            <dt><span class="term">begin</span></dt>
            <dd><p>
                An iterator pointing to the start of a sequence of endpoints.
            </p></dd>
            <dt><span class="term">connect_condition</span></dt>
            <dd>
                <p>
                    A function object that is called prior to each connection attempt.
                    The signature of the function object must be:
                </p>
                <pre class="programlisting"><span class="keyword">bool</span> <span
                        class="identifier">connect_condition</span><span class="special">(</span>
    <span class="keyword">const</span> <span class="identifier">asio</span><span class="special">::</span><span
                            class="identifier">error_code</span><span class="special">&amp;</span> <span
                            class="identifier">ec</span><span class="special">,</span>
    <span class="keyword">const</span> <span class="keyword">typename</span> <span
                            class="identifier">Protocol</span><span class="special">::</span><span class="identifier">endpoint</span><span
                            class="special">&amp;</span> <span class="identifier">next</span><span
                            class="special">);</span>
</pre>
                <p>
                    The <code class="computeroutput"><span class="identifier">ec</span></code> parameter
                    contains the result from the most recent connect operation. Before
                    the first connection attempt, <code class="computeroutput"><span class="identifier">ec</span></code>
                    is always set to indicate success. The <code class="computeroutput"><span
                        class="identifier">next</span></code>
                    parameter is the next endpoint to be tried. The function object should
                    return true if the next endpoint should be tried, and false if it
                    should be skipped.
                </p>
            </dd>
            <dt><span class="term">ec</span></dt>
            <dd><p>
                Set to indicate what error occurred, if any. If the sequence is empty,
                set to <code class="computeroutput"><span class="identifier">asio</span><span
                    class="special">::</span><span class="identifier">error</span><span class="special">::</span><span
                    class="identifier">not_found</span></code>. Otherwise, contains
                the error from the last connection attempt.
            </p></dd>
        </dl>
    </div>
    <h6>
        <a name="asio.reference.connect.overload10.h1"></a>
        <span><a name="asio.reference.connect.overload10.return_value"></a></span><a class="link"
                                                                                     href="overload10.html#asio.reference.connect.overload10.return_value">Return
        Value</a>
    </h6>
    <p>
        On success, an iterator denoting the successfully connected endpoint. Otherwise,
        the end iterator.
    </p>
    <h6>
        <a name="asio.reference.connect.overload10.h2"></a>
        <span><a name="asio.reference.connect.overload10.remarks"></a></span><a class="link"
                                                                                href="overload10.html#asio.reference.connect.overload10.remarks">Remarks</a>
    </h6>
    <p>
        This overload assumes that a default constructed object of type <code class="computeroutput"><span
            class="identifier">Iterator</span></code> represents the end of the sequence.
        This is a valid assumption for iterator types such as <code class="computeroutput"><span
            class="identifier">asio</span><span class="special">::</span><span class="identifier">ip</span><span
            class="special">::</span><span class="identifier">tcp</span><span class="special">::</span><span
            class="identifier">resolver</span><span class="special">::</span><span
            class="identifier">iterator</span></code>.
    </p>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%">
    <tr>
        <td align="left"></td>
        <td align="right">
            <div class="copyright-footer">Copyright © 2003-2022 Christopher M. Kohlhoff<p>
                Distributed under the Boost Software License, Version 1.0. (See accompanying
                file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
            </p>
            </div>
        </td>
    </tr>
</table>
<hr>
<div class="spirit-nav">
    <a accesskey="p" href="overload9.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u"
                                                                                          href="../connect.html"><img
        src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png"
                                                                                            alt="Home"></a><a
        accesskey="n" href="overload11.html"><img src="../../../next.png" alt="Next"></a>
</div>
</body>
</html>
